home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Games Collection 1 / software vault.zip / software vault / CDR06 / TWCAPD10.ZIP / TWCAPD.DOC next >
Text File  |  1993-04-12  |  18KB  |  600 lines
  1.  
  2.  
  3.  
  4.  
  5.                                                ▄
  6.        ████████  ██         ██   ▄█████▄    ███████   █████▄   █████▄
  7.           ██     ██         ██  ██▀   ▀▀▀   ██   ██   ██   ██  ██   ██
  8.           ██     ██   ▄█▄   ██  ██          ███████   ██▄▄▄█▀  ██   ██
  9.           ██      ██ ██ ██ ██   ██▄   ▄▄▄   ██   ██   ██▀▀▀    ██   ██
  10.           ██      ▀███   ███▀    ▀█████▀   ███   ███  ██       █████▀
  11.  
  12.  
  13.  
  14.  
  15.                                  Version 1.0
  16.  
  17.                          Trade Wars 2002 Capture Door
  18.                                by Albin Gersich
  19.                    (C) Copyright 1993 - Sasquatch Software
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62. ╔════════════════════════════════════════════════════════════════════════════╗
  63. ║                             Table of Contents                              ║
  64. ╚════════════════════════════════════════════════════════════════════════════╝
  65.  
  66.  
  67.   1   Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  68.  
  69.        1.1   Features . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  70.        1.2   Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . .   4
  71.        1.3   Acknowledgements . . . . . . . . . . . . . . . . . . . . . .   4
  72.        1.4   Files  . . . . . . . . . . . . . . . . . . . . . . . . . . .   4
  73.        1.5   Trademarks . . . . . . . . . . . . . . . . . . . . . . . . .   5
  74.        1.6   Compatibility  . . . . . . . . . . . . . . . . . . . . . . .   5
  75.        1.7   Support and Distribution . . . . . . . . . . . . . . . . . .   6
  76.        1.8   Licensing (Free) . . . . . . . . . . . . . . . . . . . . . .   6
  77.  
  78.  
  79.   2   Command Format  . . . . . . . . . . . . . . . . . . . . . . . . . .   7
  80.  
  81.  
  82.   3   Configuration File  . . . . . . . . . . . . . . . . . . . . . . . .   8
  83.  
  84.  
  85.   4   Using TWCAPD  . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  86.  
  87.  
  88.   5   Error Levels  . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  89.  
  90.  
  91.   6   Future Plans  . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.                                     Page 2
  120.  
  121.  
  122. ╔════════════════════════════════════════════════════════════════════════════╗
  123. ║ Section  1                    Introduction                                 ║
  124. ╚════════════════════════════════════════════════════════════════════════════╝
  125.  
  126.     I got the idea for this door from a message Rick Blackwell posted in the
  127.   Fido national TW echo.  A sysop of one of the boards he plays on setup my
  128.   Trade Wars 2002 capture (TWCAP) program, which was developed for local
  129.   players to capture data to use with the offline player utilities, as a menu
  130.   selection so all players could use it and download a file.  I thought that
  131.   was a neat idea.  Humm, a nice recipe for a door.  Take my TWCAP program,
  132.   add in OpenDoors (a nice door library), stir.  Mix in a little spice and
  133.   simmer to get the flavor just right.
  134.  
  135.     This door allows the user to capture some of the TW2002 game reports
  136.   without entering the game.  Users who can not enter computer interrogation
  137.   mode in the game (because their computer does not support the ALT sequence
  138.   or their communications programs intercepts the ALT keys) can use this door
  139.   to get the data.  For players who can capture the data inside the game this
  140.   door provides an alternate and convenient method for capturing the reports
  141.   You can even use this door while remaining cloaked in the game.
  142.  
  143.     This door can be used by local or remote players and replaces my other
  144.   TWCAP program.  The Trade Wars data files will be read and the following
  145.   reports can be created:
  146.  
  147.                         View Game Status
  148.                         Deployed Fighter Scan
  149.                         Deployed Mine Scan
  150.                         Avoided Sectors
  151.                         CIM Sector Report
  152.                         CIM Port Report
  153.  
  154.   They are the reports used by TWASSIST v1.0 but the data can be used with
  155.   other utilities.  The file will look just like it had been captured during
  156.   a game session.
  157.  
  158.  
  159. ░▒▓█  1.1  █▓▒░  Features
  160.  
  161.     Supports many types of drop files allowing it to run on a wide variety
  162.      of BBSes.
  163.  
  164.     Easy to setup, whether single line or multi-line.
  165.  
  166.     Local option for use without a drop file.
  167.  
  168.     DESQview aware.  CPU time is given up while waiting for input.
  169.  
  170.     Error levels upon door exit for those who wish to monitor things like
  171.      drop-carriers, keyboard inactivity timeout, etc.
  172.  
  173.     Sysop shell to DOS uses EMS memory if available.
  174.  
  175.     Writes to a log file on who used the door and any error info.
  176.  
  177.  
  178.  
  179.                                     Page 3
  180.  
  181.  
  182. ░▒▓█  1.2  █▓▒░  Disclaimer
  183.  
  184.     The TWCAPD package is provided AS IS.  Sasquatch Software makes no
  185.   warranty, either expressed or implied, with respect to the software or
  186.   documentation, including but not limited to their quality, performance,
  187.   merchantability, or fitness for a particular purpose. In no event will
  188.   Sasquatch Software or the author be liable for direct, indirect, special,
  189.   incidental, or consequential damages arising out of the use, misuse, or
  190.   inability to use the software or documentation, even if advised of the
  191.   possibility of such damages.
  192.  
  193.  
  194. ░▒▓█  1.3  █▓▒░  Acknowledgements
  195.  
  196.     I would like to give thanks to Gary and Mary Ann Martin of Martech
  197.   Software, Inc. for the game Trade Wars 2002.  It has provided me with
  198.   hours upon hours of entertainment and excitement.
  199.  
  200.     And to Jason Boyd for providing the formats to the Trade Wars 2002 data
  201.   files which helped in the development of the original Trade Wars 2002
  202.   Capture program this door is based on.
  203.  
  204.     Thanks also to Rick Blackwell for posting the message that gave me the
  205.   idea for this door.
  206.  
  207.     And thanks to Brian Pirie for OpenDoors.  A nice C door library which
  208.   made developing this door very easy.  I probably wouldn't have done it
  209.   without OpenDoors.
  210.  
  211.     I would also like to acknowledge Dan Roseen for running a few tests for
  212.   me and allowing me to distribute and support this door through his BBS.
  213.  
  214.  
  215. ░▒▓█  1.4  █▓▒░  Files
  216.  
  217.   The TWCAPD version 1.0 package (TWCAPD10.ZIP) contains the following files:
  218.  
  219.     TWCAPD  .DOC     18233 04-12-93   1:00a     This document
  220.     TWCAPD  .EXE    104458 04-12-93   1:00a     The executable program
  221.     TWCAPD  .HLP      2848 04-12-93   1:00a     On-line help file.
  222.  
  223.   Other files used by the program:
  224.  
  225.     TWCAPD  .CFG      The configuration file for the door.  Must be located
  226.                       in the same directory as the executable.
  227.  
  228.     TWCAPD  .LOG      The door's log file.  Located in the TW directory.
  229.                       Contains information about who used the door and any
  230.                       errors encountered.
  231.  
  232.     TWCAPD  .TXT      This is the temporary file created for user downloads.
  233.                       The file is created in the TW directory and deleted
  234.                       when done.
  235.  
  236.  
  237.  
  238.  
  239.                                       Page 4
  240.  
  241.  
  242.  
  243. ░▒▓█  1.5  █▓▒░  Trademarks
  244.  
  245.   IBM is a trademark of International Business Machines Corporation.
  246.   MS-DOS is a registered trademark of Microsoft Corporation.
  247.  
  248.  
  249. ░▒▓█  1.6  █▓▒░  Compatibility
  250.  
  251.   Trade Wars 2002:
  252.  
  253.       This program has been tested for compatibility with Trade Wars 2002
  254.       v1.03d, a door game by Martech Software Inc.  It should be compatible
  255.       with v1.03 but has not been tested with it.  Compatibility with other
  256.       versions or modified games is not guaranteed.
  257.  
  258.   Operating system:
  259.  
  260.       TWCAPD runs on an IBM or 100% compatible PC or AT running DOS.  It
  261.       has been tested under MS-DOS version 5.0.  Compatibility with other
  262.       versions or operating systems is not guaranteed.]
  263.  
  264.   Multitasking
  265.  
  266.       TWCAPD has been tested under DESQview version 2.41 and QEMM version
  267.       6.01.  TWCAPD will share CPU time slices when run under DESQview.
  268.  
  269.   Fossil driver:
  270.  
  271.       TWCAPD requires the BBS to be running a fossil driver when used
  272.       remotely.  Two common ones are BNU and X00.
  273.  
  274.   Supported drop files:
  275.  
  276.       DORINFOn.DEF   (only if -n node option is used on command line)
  277.       DORINFO1.DEF
  278.       CHAIN.TXT
  279.       SFDOORS.DAT
  280.       DOOR.SYS
  281.       CALLINFO.BBS
  282.       EXITINFO.BBS *
  283.  
  284.     * Only the standard EXITINFO.BBS file is supported.  Larger files (over
  285.       476 bytes) used by some BBSes (e.g. RA, QBBS) will be ignored.  This
  286.       way BBS specific changes in this file will not cause problems with the
  287.       door.  For example, on a RA BBS the DORINFO1.DEF file will be read but
  288.       the EXITINFO.BBS file will be ignored so it will run under RA v1.x and
  289.       RA v2.0 eventhough the EXITINFO.BBS file was changed between the two RA
  290.       versions.
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.                                       Page 5
  300.  
  301.  
  302. ░▒▓█  1.7  █▓▒░  Support and Distribution
  303.  
  304.     New releases of TWCAPD can be downloaded or file-requested from Dan
  305.   Roseen's BBS, The Night Owl, as shown below.  If you are logging in you will
  306.   have to fill out a new user questionnaire.  Once you have done this you will
  307.   have enough access to download TWCAPD without complete user verification.
  308.  
  309.     If you are experiencing problems, call The Night Owl BBS or write to the
  310.   address below.  Provide a detailed description of the problem and any data
  311.   related to the problem.  If you send mail on The Night Owl, send it to the
  312.   author, Albin Gersich.  The sysop is not responsible for support of TWCAPD
  313.   so do not bother him with messages or chats.  A special message area for
  314.   another program, TWASSIST, by the same author has been setup.  You may use
  315.   this message area to send mail to the author.  This area has file attach
  316.   capability, allowing you to attach files of interest to your message.
  317.  
  318.   Mail can be sent to:
  319.  
  320.      Sasquatch Software
  321.      P.O. Box 4331
  322.      Kent, WA   98032
  323.  
  324.   Support and Distribution:
  325.   ─────────────────────────
  326.   Sysop:       Dan Roseen     (not the author)
  327.   BBS:         The Night Owl
  328.   Fidonet:     1:343/102
  329.  
  330.   Login:       (206)631-4949       24 Hrs.      Kent, WA - USA
  331.                1200/2400
  332.  
  333.   Mail/FREQ:   1:343/102           (this node is NOT for login)
  334.                USRobotics DS HST/V.32bis/V.42bis
  335.  
  336.   Comment:     For downloading latest version:  Download TWCAPD*.ZIP
  337.                           For file-requesting:  Use the magic name "TWCAPD"
  338.                                                 or request TWCAPD*.ZIP
  339.  
  340.  
  341. ░▒▓█  1.8  █▓▒░  Licensing (Free)
  342.  
  343.     The software and documentation is copyrighted and is protected by United
  344.   States copyright laws and international treaty provisions.  All rights
  345.   are reserved by Sasquatch Software.  The software is owned by Sasquatch
  346.   Software and title remains in Sasquatch Software.  You may distribute
  347.   the program as long as the entire package (as described in the section
  348.   titled Files) is distributed together and no fee is charged for the
  349.   software (a nominal distribution or shipping fee is ok).  You may not
  350.   decompile, disassemble, modify, merge, or reverse engineer the software
  351.   in any way.
  352.  
  353.     TWCAPD is free.  You are granted a license to use the software
  354.   indefinitely.  No consideration is required or expected.  Contributions
  355.   to provide incentive for the development of utilities are appreciated.
  356.   They may be sent to the mail address above.
  357.  
  358.  
  359.                                     Page 6
  360.  
  361.  
  362. ╔════════════════════════════════════════════════════════════════════════════╗
  363. ║ Section  2                    Command Format                               ║
  364. ╚════════════════════════════════════════════════════════════════════════════╝
  365.  
  366.   NOTE:  Options are recognized with either a dash (-) or a slash (/) as the
  367.          first character.
  368.  
  369.   TWCAPD [-n node] [-local "USER NAME"] [-tw directory]
  370.  
  371.   -n node          Tells the door which node it is running on.  Only useful
  372.                    if the door drop file does not have the node number or for
  373.                    a BBS that uses a DORINFO?.DEF drop file where ? is a
  374.                    number other than 1.  For most BBSes this option is not
  375.                    needed.
  376.  
  377.   -local "USER NAME"  If you want to run in local mode without creating a
  378.                    drop file.  In this case you must supply the user name
  379.                    to find in the Trade Wars data files.  Without a drop
  380.                    file TWCAPD will not know the name of the BBS.  In this
  381.                    case the View Game Status report will show "SOMETHING"
  382.                    as the name of the BBS.
  383.  
  384.   -tw directory    Specify the location of the Trade Wars data files.  This
  385.                    overrides the config file entry.  If not specified by this
  386.                    option or in the config file the default is to check the
  387.                    current directory and then the directory where the TWCAPD
  388.                    executable resides.  The TW directory is also used for
  389.                    the temporary TWCAPD.TXT file created before the user
  390.                    downloads it.
  391.  
  392.     Trade Wars 2002 does not support multiple users at the same time and
  393.   neither does TWCAPD.  Multi-node BBSes will want to use the same locking
  394.   mechanism on TWCAPD as is used to keep multiple people out of TW.  This will
  395.   prevent anyone from using TWCAPD to access the TW data files at the same
  396.   time someone is using them in the game, and vice-versa.
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.                                     Page 7
  420.  
  421.  
  422. ╔════════════════════════════════════════════════════════════════════════════╗
  423. ║ Section  3                  Configuration File                             ║
  424. ╚════════════════════════════════════════════════════════════════════════════╝
  425.  
  426.     Three things can be specified in a configuration file.  First is the
  427.   inactivity timeout in seconds, second the pathname to DSZ, or other file
  428.   transfer program command line compatible with DSZ, used for downloads, and
  429.   third is the TW directory.  The configuration file name is TWCAPD.CFG and
  430.   must be located in the same directory as the executable.  Sample TWCAPD.CFG:
  431.  
  432. 240
  433. DSZ
  434. \tw
  435.  
  436.   If the configuration file does not exist these defaults will be used:
  437.  
  438.     Inactivity timeout:  240 seconds
  439.           DSZ pathname:  DSZ
  440.           TW directory:  current directory or the directory containing
  441.                          the TWCAPD executable.
  442.  
  443.   The TW directory specification is to simplify use on BBSes that have only
  444.   one TW game.  The command line argument will override the directory in the
  445.   config file allowing the door to be used on a test game in special cases
  446.   or on boards with multiple TW games.
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.                                     Page 8
  480.  
  481.  
  482. ╔════════════════════════════════════════════════════════════════════════════╗
  483. ║ Section  4                     Using TWCAPD                                ║
  484. ╚════════════════════════════════════════════════════════════════════════════╝
  485.  
  486.  
  487.     TWCAPD is easy to setup whether your BBS is single line or multi-line.
  488.   You may locate the TWCAPD files anywhere.  See the earlier section on
  489.   setting up the configuration file.  For a single line BBS simply have the
  490.   BBS menu execute TWCAPD.  For example:
  491.  
  492.     C:\TW\TWCAPD.EXE
  493.  
  494.   TWCAPD will look for the drop file in the current directory and read the
  495.   configuration file for the pathname to DSZ and the TW directory.  If the
  496.   BBS has multiple TW games then setup separate menu selections for each
  497.   one specifying the TW directory for that menu item.  For example:
  498.  
  499.     C:\TW\TWCAPD.EXE  -TW C:\TW2
  500.  
  501.     A multi-line BBS can use the same approach as for the single line BBS
  502.   except you will want to employ a locking mechanism to keep more than one
  503.   user from accessing the TW game data files at the same time, the same
  504.   way you keep more than one user from playing the game at the same time.
  505.   Use the same locking mechanism for TWCAPD as is used for TW.  This will
  506.   keep users from accessing TWCAPD when someone is playing TW and vice-versa.
  507.   It is unknown what will happen to the games data if TWCAPD is run at the
  508.   same time a player is in the game modifying the files.
  509.  
  510.     TWCAPD may also be used locally from DOS.  Maybe for gathering data on
  511.   a test game.  When run from DOS without a drop file your user name must
  512.   be supplied on the command line.  For example:
  513.  
  514.     C:\TW\TWCAPD.EXE  -LOCAL "Albin Gersich"  -TW C:\TEST_TW
  515.  
  516.  
  517. ╔════════════════════════════════════════════════════════════════════════════╗
  518. ║ Section  5                     Error Levels                                ║
  519. ╚════════════════════════════════════════════════════════════════════════════╝
  520.  
  521.     TWCAPD will exit with different error levels depending on the reason for
  522.   the exit.  The error levels are as follows:
  523.  
  524.     0 - A critical error has occurred
  525.     1 - Carrier lost, user off-line
  526.     2 - Sysop terminated call, user off-line
  527.     3 - User time used up, user STILL ON-LINE
  528.     4 - Keyboard inactivity timeout, user off-line
  529.    10 - User not found in TW data file.
  530.    20 - An error prevented the door from running.
  531.    50 - User requested exit.
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.                                     Page 9
  540.  
  541.  
  542. ╔════════════════════════════════════════════════════════════════════════════╗
  543. ║ Section  6                     Future Plans                                ║
  544. ╚════════════════════════════════════════════════════════════════════════════╝
  545.  
  546.     There are no plans for future versions of TWCAPD.
  547.  
  548.     Comments and suggestions can be sent through the Fidonet Trade Wars echo
  549.   to Albin Gersich.  To report a problem, send a detailed letter or message
  550.   to the author on The Night Owl BBS.  Refer to the section on Support and
  551.   Distribution for more information.
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.                                    Page 10
  600.